SWIFT-434 Document how to use the driver with TLS/SSL #438
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kmahar
suggested changes
Apr 2, 2020
Contributor
kmahar
left a comment
kmahar
left a comment
There was a problem hiding this comment.
looks really good! just some small nits
mbroadst
reviewed
Apr 2, 2020
kmahar
approved these changes
Apr 2, 2020
Guides/TLS.md
Outdated
| @@ -0,0 +1,81 @@ | |||
| # TLS/SSL and MongoSwift | |||
Contributor
There was a problem hiding this comment.
whoops I missed that MongoSwift was used in the title too :)
Contributor
Author
There was a problem hiding this comment.
updated to "Swift Driver TLS/SSL" guide. Also filed a ticket for updating the various other guides as well
mbroadst
approved these changes
Apr 2, 2020
Codecov Report
@@ Coverage Diff @@
## master #438 +/- ##
==========================================
+ Coverage 77.88% 77.94% +0.06%
==========================================
Files 115 115
Lines 12330 12332 +2
==========================================
+ Hits 9603 9612 +9
+ Misses 2727 2720 -7
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SWIFT-434
As the ticket describes, this PR adds documentation for describing how to ensure clients are using the latest TLS protocols. As part of that, figured it made sense to write the rest of the guide, since we didn't already have one. The guide was heavily influenced by pymongo's guide on the same topic.
One API change that's important to note: I added a generic
tlsoption toClientOptions, since it seems reasonable to me that a user would want to enable TLS but not necessarily identify all the client's connecting to the database. This option is included in the URI options spec, and I think most drivers support it (pymongo does at least). cc @mbroadst